r/compute_cluster: New resource #487

vancluever · 2018-04-25T15:24:13Z

This adds the vsphere_compute_cluster resource, which allows one to manage compute clusters within Terraform.

The current supported workflow requires that the hosts already exist in vSphere. We have opted to use this method because it allows for a unified workflow for getting hosts into (requiring that they can be referenced as a HostSystem object already) and out of (putting a host into maintenance mode, evacuating it, and moving it to a neutral spot in inventory) a cluster, versus having to support this plus additional methods, like allowing hosts to be added with AddHost_Task (which has its own implications, such as passwords needing to be added in state).

Eventually, the latter workflow may be relegated to a vsphere_host resource, which we could use to handle the lifecycle of a standalone host, which could then be used as a dependency to vsphere_cluster. For now, this allows people to add their hosts with a tool like govc, and then get their data as inputs for the cluster with the vsphere_host data source.

This commit adds pretty much most of the workflow code for Create, in addition to other functions needed for read and update. More helpers will probably be added as work continues on the resource.

This commit includes the resource flatteners for the entire resource.

Finished rest of CRUD and import, resource is now ready to have acceptance tests written for it. Commit also contains some small modifications to the vsphere_datastore_cluster resource as I noticed some error messages were off as I was copying the code (a lot of the code was drawn from this resource as a template).

Tests are failing right now, but this is the main scaffolding. Currently working on the basic test right now, working through config spec issues.

Had to fix a couple of configuration issues (one incorrect default, add an attribute skip to prevent a spurious diff), and we were missing host add/removal on update. Both of these have been fixed, and now the basic example passes.

Added/updated/validated the DRS/HA test as functional, Ensuring basic DRS and HA works. Also added a force_evacuate_on_destroy flag - this allows us to simplify testing by having the resource auto-evacuate the cluster on destroy. Users may also want this option as well but I have disabled it by default as auto-evacuation is by nature fragile, as its smooth operation pretty much depends on a cluster devoid of VMs so that no HA constraints are hit during the removal of hosts.

All test have now been updated and vetted. Small updates to things (namely folder helpers) to accommodate. Moving on to documentation.

Forgot to add this one - does a test where we create a VM in the cluster. This one depends on the test environment having the same setup as the live cluster normally used for VM testing. This is the case in our own lab and was how VSPHERE_ESXI_HOST5-7 were intended to be used.

Documentation is now complete, in addition a few updates to attributes and descriptions in the schema.

Added a function to set defaults for all attributes that are not covered in read, except for datacenter_id which we do in a separate read function to make sure that is always set, even on import. This allows a clean import test without requiring any variables be entered into ImportStateVerify.

bill-rich · 2018-04-25T21:44:52Z

vsphere/internal/helper/folder/folder_helper.go

@@ -220,6 +224,18 @@ func DatastoreFolderFromObject(client *govmomi.Client, obj interface{}, relative
 	return validateDatastoreFolder(folder)
 }

+// HostFolderFromObject returns an *object.Folder from a given object, and
+// relative host folder path. If no such folder is found, of if it is not a


"...found, or if it is not a"

bill-rich · 2018-04-25T23:00:24Z

website/docs/r/compute_cluster.html.markdown

+  `120` (2 minutes).
+* `ha_vm_maximum_resets` - (Optional) The maximum number of resets that HA will
+  perform to a virtual machine when responding to a failure event. Default: `3`
+* `ha_vm_maximum_failure_window` - (Optional) The length of the reset window in


Is this in minutes or seconds?

It's seconds, contrary to this diff here it's been fixed (just added on another line).

bill-rich · 2018-04-25T23:01:43Z

website/docs/r/compute_cluster.html.markdown

+whether or not specific VM operations are permitted in the cluster in order to
+protect the reliability of the cluster. Based on the constraints defined in
+these settings, operations such as power on or migration operations may be
+blocked. To ensure that enough capacity remains to react to host failures.


"blocked to ensure..."

bill-rich · 2018-04-25T23:11:17Z

website/docs/r/compute_cluster.html.markdown

+A large number of settings in the `vsphere_compute_cluster` resource require a
+specific version of vSphere to function. Rather than include warnings at every
+setting or section, these settings are documented below.  Note that this list
+are for cluster-specific attributes only and does not include [`tags`](#tags),


"is for..."

bill-rich

Looks great! Just the one possible issue and a few grammatical changes.

bill-rich · 2018-04-26T06:04:53Z

vsphere/resource_vsphere_compute_cluster.go

+		DrsConfig: expandClusterDrsConfigInfo(d),
+	}
+
+	if version.Newer(viapi.VSphereVersion{Product: version.Product, Major: 6, Minor: 5}) {


These are all doing the same version check. It looks like they either need to be checking different versions or can be combined into one conditional.

These are now consolidated in ace5a9c.

bill-rich · 2018-04-26T06:06:28Z

vsphere/resource_vsphere_compute_cluster.go

+		return err
+	}
+
+	if version.Newer(viapi.VSphereVersion{Product: version.Product, Major: 6, Minor: 5}) {


Same here as above

The value is in seconds, which was left out of the ha_vm_maximum_failure_window value.

For the version requirements section this time.

These were doing all the same version check, so just group them up.

bill-rich

LGTM!

vancluever · 2018-04-26T15:30:01Z

Thanks @bill-rich!

vancluever added 11 commits April 17, 2018 14:38

r/compute_cluster: Resource function scaffolding and schema

88b398a

r/compute_cluster: Create workflow complete

1406a89

This commit adds pretty much most of the workflow code for Create, in addition to other functions needed for read and update. More helpers will probably be added as work continues on the resource.

r/compute_cluster: Resource flatteners

d312fc3

This commit includes the resource flatteners for the entire resource.

r/compute_cluster: Initial testing

17c7003

Tests are failing right now, but this is the main scaffolding. Currently working on the basic test right now, working through config spec issues.

r/compute_cluster: Basic test now functional

6ac6778

Had to fix a couple of configuration issues (one incorrect default, add an attribute skip to prevent a spurious diff), and we were missing host add/removal on update. Both of these have been fixed, and now the basic example passes.

r/compute_cluster: Tests now complete

dbfffe1

All test have now been updated and vetted. Small updates to things (namely folder helpers) to accommodate. Moving on to documentation.

r/compute_cluster_resource: Documentation

4faa9aa

Documentation is now complete, in addition a few updates to attributes and descriptions in the schema.

vancluever added enhancement Type: Enhancement new-resource Feature: New Resource labels Apr 25, 2018

vancluever requested a review from a team April 25, 2018 15:24

bill-rich reviewed Apr 25, 2018

View reviewed changes

bill-rich reviewed Apr 26, 2018

View reviewed changes

vancluever added 5 commits April 26, 2018 07:39

helper/folder: Slight grammar correction

e91dc4b

r/compute_cluster: Specify VM restart window unit value

462e6af

The value is in seconds, which was left out of the ha_vm_maximum_failure_window value.

r/compute_cluster: Another grammar fix in docs

cead28f

r/compute_cluster: More doc grammar fixes/rewording

041e7c0

For the version requirements section this time.

r/compute_cluster: Consolidate top-level config expansions

ace5a9c

These were doing all the same version check, so just group them up.

bill-rich approved these changes Apr 26, 2018

View reviewed changes

vancluever merged commit 911b942 into master Apr 26, 2018

vancluever deleted the f-compute-cluster-resource branch April 26, 2018 17:17

ghost locked and limited conversation to collaborators Apr 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

r/compute_cluster: New resource #487

r/compute_cluster: New resource #487

vancluever commented Apr 25, 2018

bill-rich Apr 25, 2018

bill-rich Apr 25, 2018

vancluever Apr 26, 2018

bill-rich Apr 25, 2018

bill-rich Apr 25, 2018

bill-rich left a comment

bill-rich Apr 26, 2018

vancluever Apr 26, 2018

bill-rich Apr 26, 2018

vancluever Apr 26, 2018

bill-rich left a comment

vancluever commented Apr 26, 2018

r/compute_cluster: New resource #487

r/compute_cluster: New resource #487

Conversation

vancluever commented Apr 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bill-rich left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bill-rich left a comment

Choose a reason for hiding this comment

vancluever commented Apr 26, 2018